Inside Macintosh: QuickDraw GX Objects /

Chapter 5 - Ink Objects / Ink Objects Reference

Functions / Getting and Setting an Ink's Transfer Mode

GXSetInkTransfer

You can use the GXSetInkTransfer function to assign a transfer mode to an ink object.

void GXSetInkTransfer(gxInk target, const gxTransferMode *data);

target

A reference to the ink to assign the transfer mode to.

data

A pointer to a transfer mode structure containing the transfer mode to assign to the ink.

DESCRIPTION

The GXSetInkTransfer function assigns the transfer mode pointed to by the data parameter to the ink object referenced in the target parameter.

SPECIAL CONSIDERATIONS

The color space of the transfer mode pointed to by the data parameter cannot be gxNoSpace or any of the packed color spaces (such as, for example, gxRGB16Space). If you specify gxHighlightMode in some but not all components of the transfer mode, this function posts an inconsistent_parameters error.

ERRORS, WARNINGS, AND NOTICES

Errors
out_of_memory
ink_is_nil
transferMode_is_nil
parameter_out_of_range	(debugging version)
inconsistent_parameters	(debugging version)
invalid_transferMode_colorSpace	(debugging version)
colorSpace_out_of_range	(debugging version)
colorSet_access_restricted	(debugging version)
colorProfile_access_restricted	(debugging version)

SEE ALSO

Transfer modes are described in the sections "About Transfer Modes" beginning on page 5-11, and "Working With Transfer Modes" beginning on page 5-44.

To examine the transfer mode of an ink object, use the GXGetInkTransfer function, described in the previous section.

To assign a transfer mode to the ink object associated with a shape, use the GXSetShapeTransfer function, described on page 5-75.

Color spaces are described in the chapter "Colors and Color-Related Objects" in this book.